micropump.h File Reference

This file contains API for Micro Pump Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures
struct	micropump_t
	Micro Pump Click context object. More...
struct	micropump_cfg_t
	Micro Pump Click configuration object. More...

Macros
#define	MICROPUMP_V_TO_MA   1.5
	Micro Pump current calculation setting.
#define	MICROPUMP_NUM_CONVERSIONS   200
	Micro Pump default ADC samples number for averaging.
#define	MICROPUMP_TIMEOUT_MS   2000
	Micro Pump timeout setting.
#define	MICROPUMP_MOTOR_COAST   0
	Micro Pump motor control setting.
#define	MICROPUMP_MOTOR_FORWARD   1
#define	MICROPUMP_MOTOR_REVERSE   2
#define	MICROPUMP_MOTOR_BRAKE   3
#define	MICROPUMP_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	micropump_return_value_t { MICROPUMP_OK = 0 , MICROPUMP_ERROR = -1 }
	Micro Pump Click return value data. More...

Functions
void	micropump_cfg_setup (micropump_cfg_t *cfg)
	Micro Pump configuration object setup function.
err_t	micropump_init (micropump_t *ctx, micropump_cfg_t *cfg)
	Micro Pump initialization function.
err_t	micropump_read_adc_raw (micropump_t *ctx, uint16_t *data_out)
	Micro Pump read AN pin value function.
err_t	micropump_read_adc_voltage (micropump_t *ctx, float *data_out)
	Micro Pump read AN pin voltage level function.
err_t	micropump_read_adc_voltage_avg (micropump_t *ctx, uint16_t num_conv, float *voltage_avg)
	Micro Pump read AN pin voltage level average function.
err_t	micropump_set_vref (micropump_t *ctx, float vref)
	Micro Pump set vref function.
void	micropump_set_in1_pin (micropump_t *ctx)
	Micro Pump set IN1 pin function.
void	micropump_clear_in1_pin (micropump_t *ctx)
	Micro Pump clear IN1 pin function.
void	micropump_set_in2_pin (micropump_t *ctx)
	Micro Pump set IN2 pin function.
void	micropump_clear_in2_pin (micropump_t *ctx)
	Micro Pump clear IN2 pin function.
void	micropump_drive_motor (micropump_t *ctx, uint8_t state)
	Micro Pump drive motor function.
err_t	micropump_calib_offset (micropump_t *ctx)
	Micro Pump calib offset function.
err_t	micropump_get_out_current (micropump_t *ctx, float *current)
	Micro Pump get out current function.

Detailed Description

This file contains API for Micro Pump Click Driver.

Enumeration Type Documentation

micropump_return_value_t

enum micropump_return_value_t

Micro Pump Click return value data.

Predefined enum values for driver return values.

Enumerator
MICROPUMP_OK
MICROPUMP_ERROR